<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>JiraTestCase xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * Copyright (c) 2008, Roman Bosak All rights reserved.</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> * </em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * Redistribution and use in source and binary forms, with or without</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> * modification, are permitted provided that the following conditions are met:</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> *  - Redistributions of source code must retain the above copyright notice,</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * this list of conditions and the following disclaimer. - Redistributions in</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> * binary form must reproduce the above copyright notice, this list of</em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> * conditions and the following disclaimer in the documentation and/or other</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> * materials provided with the distribution. - Neither the name of the</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> * DailyDevelopment nor the names of its contributors may be used to endorse or</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * promote products derived from this software without specific prior written</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> * permission.</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * </em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</em>
<a name="16" href="#16">16</a>  <em class="jxr_comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</em>
<a name="17" href="#17">17</a>  <em class="jxr_comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</em>
<a name="18" href="#18">18</a>  <em class="jxr_comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</em>
<a name="19" href="#19">19</a>  <em class="jxr_comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</em>
<a name="20" href="#20">20</a>  <em class="jxr_comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</em>
<a name="21" href="#21">21</a>  <em class="jxr_comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</em>
<a name="22" href="#22">22</a>  <em class="jxr_comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</em>
<a name="23" href="#23">23</a>  <em class="jxr_comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</em>
<a name="24" href="#24">24</a>  <em class="jxr_comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</em>
<a name="25" href="#25">25</a>  <em class="jxr_comment"> * POSSIBILITY OF SUCH DAMAGE.</em>
<a name="26" href="#26">26</a>  <em class="jxr_comment"> */</em>
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">package</strong> com.atlassian.jira.web.action;
<a name="28" href="#28">28</a>  
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> java.lang.reflect.Field;
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.easymock.EasyMock;
<a name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> org.junit.Before;
<a name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> org.picocontainer.PicoContainer;
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> webwork.action.ActionContext;
<a name="37" href="#37">37</a>  
<a name="38" href="#38">38</a>  <strong class="jxr_keyword">import</strong> com.atlassian.jira.ComponentManager;
<a name="39" href="#39">39</a>  <strong class="jxr_keyword">import</strong> com.atlassian.jira.issue.CustomFieldManager;
<a name="40" href="#40">40</a>  <strong class="jxr_keyword">import</strong> com.atlassian.jira.issue.IssueManager;
<a name="41" href="#41">41</a>  <strong class="jxr_keyword">import</strong> com.atlassian.jira.portal.PortalManager;
<a name="42" href="#42">42</a>  <strong class="jxr_keyword">import</strong> com.atlassian.jira.security.JiraAuthenticationContext;
<a name="43" href="#43">43</a>  <strong class="jxr_keyword">import</strong> com.atlassian.jira.security.PermissionManager;
<a name="44" href="#44">44</a>  <strong class="jxr_keyword">import</strong> com.atlassian.jira.util.EmailFormatter;
<a name="45" href="#45">45</a>  <strong class="jxr_keyword">import</strong> com.atlassian.jira.util.GroupPermissionChecker;
<a name="46" href="#46">46</a>  <strong class="jxr_keyword">import</strong> com.atlassian.seraph.auth.DefaultAuthenticator;
<a name="47" href="#47">47</a>  <strong class="jxr_keyword">import</strong> com.dailydev.jira.portal.IDashboardSharingPortalManager;
<a name="48" href="#48">48</a>  <strong class="jxr_keyword">import</strong> com.dailydev.jira.portal.config.IPortalPageSharingConfiguration;
<a name="49" href="#49">49</a>  <strong class="jxr_keyword">import</strong> com.opensymphony.user.ProviderAccessor;
<a name="50" href="#50">50</a>  <strong class="jxr_keyword">import</strong> com.opensymphony.user.User;
<a name="51" href="#51">51</a>  <strong class="jxr_keyword">import</strong> com.opensymphony.user.provider.AccessProvider;
<a name="52" href="#52">52</a>  <strong class="jxr_keyword">import</strong> com.opensymphony.user.provider.CredentialsProvider;
<a name="53" href="#53">53</a>  
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">/**</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * This class provide default setup of Jira testing environment with registered</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> * mocks and logged user. This class is intended to be extended by concrete test</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> * cases.</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment"> * </em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment"> * @author Roman Bosak, roman.bosak@gmail.com</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment"> */</em>
<a name="61" href="#61">61</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../com/atlassian/jira/web/action/JiraTestCase.html">JiraTestCase</a> {
<a name="62" href="#62">62</a>  
<a name="63" href="#63">63</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String USER_FREUD = <span class="jxr_string">"freud"</span>;
<a name="64" href="#64">64</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String USER_JUNG = <span class="jxr_string">"jung"</span>;
<a name="65" href="#65">65</a>      <strong class="jxr_keyword">protected</strong> PicoContainer container;
<a name="66" href="#66">66</a>      <strong class="jxr_keyword">protected</strong> CustomFieldManager customFieldManager;
<a name="67" href="#67">67</a>      <strong class="jxr_keyword">protected</strong> IssueManager issueManager;
<a name="68" href="#68">68</a>      <strong class="jxr_keyword">protected</strong> HashMap&lt;String, Object&gt; session;
<a name="69" href="#69">69</a>      <strong class="jxr_keyword">protected</strong> IPortalPageSharingConfiguration configuration;
<a name="70" href="#70">70</a>      <strong class="jxr_keyword">protected</strong> IDashboardSharingPortalManager portalManager;
<a name="71" href="#71">71</a>      <strong class="jxr_keyword">protected</strong> JiraAuthenticationContext jiraAuthenticationContext;
<a name="72" href="#72">72</a>      <strong class="jxr_keyword">protected</strong> PermissionManager permissionManager;
<a name="73" href="#73">73</a>      <strong class="jxr_keyword">protected</strong> GroupPermissionChecker groupPermissionChecker;
<a name="74" href="#74">74</a>      <strong class="jxr_keyword">protected</strong> EmailFormatter emailFormatter;
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../com/atlassian/jira/web/action/JiraTestCase.html">JiraTestCase</a>() {
<a name="77" href="#77">77</a>          <strong class="jxr_keyword">super</strong>();
<a name="78" href="#78">78</a>      }
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>      <em class="jxr_javadoccomment">/**</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     * Sets up the environment for testing execution. Configuring PicoContainer</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * mock to behave as standard PicoContainer implementation and registering</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     * components required by concrete tests. Also creates one {@link User}</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * instance and registers it as logged in user.</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * </em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     * @throws Exception</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     */</em>
<a name="88" href="#88">88</a>      @Before
<a name="89" href="#89">89</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setUp() <strong class="jxr_keyword">throws</strong> Exception {
<a name="90" href="#90">90</a>          container = EasyMock.createNiceMock(PicoContainer.<strong class="jxr_keyword">class</strong>);
<a name="91" href="#91">91</a>  
<a name="92" href="#92">92</a>          <em class="jxr_comment">// creates and registers CustomFieldManager mock</em>
<a name="93" href="#93">93</a>          customFieldManager = EasyMock.createNiceMock(CustomFieldManager.<strong class="jxr_keyword">class</strong>);
<a name="94" href="#94">94</a>          EasyMock.expect(
<a name="95" href="#95">95</a>                  container.getComponentInstanceOfType(CustomFieldManager.<strong class="jxr_keyword">class</strong>))
<a name="96" href="#96">96</a>                  .andStubReturn(customFieldManager);
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>          <em class="jxr_comment">// creates and registers IssueManager mock</em>
<a name="99" href="#99">99</a>          issueManager = EasyMock.createNiceMock(IssueManager.<strong class="jxr_keyword">class</strong>);
<a name="100" href="#100">100</a>         EasyMock.expect(
<a name="101" href="#101">101</a>                 container.getComponentInstanceOfType(IssueManager.<strong class="jxr_keyword">class</strong>))
<a name="102" href="#102">102</a>                 .andStubReturn(issueManager);
<a name="103" href="#103">103</a> 
<a name="104" href="#104">104</a>         <em class="jxr_comment">// creates and registers IDashboardSharingConfiguration mock</em>
<a name="105" href="#105">105</a>         configuration = EasyMock
<a name="106" href="#106">106</a>                 .createMock(IPortalPageSharingConfiguration.<strong class="jxr_keyword">class</strong>);
<a name="107" href="#107">107</a>         EasyMock
<a name="108" href="#108">108</a>                 .expect(
<a name="109" href="#109">109</a>                         container
<a name="110" href="#110">110</a>                                 .getComponentInstanceOfType(IPortalPageSharingConfiguration.<strong class="jxr_keyword">class</strong>))
<a name="111" href="#111">111</a>                 .andStubReturn(configuration);
<a name="112" href="#112">112</a> 
<a name="113" href="#113">113</a>         <em class="jxr_comment">// creates and registers PortalManager mock</em>
<a name="114" href="#114">114</a>         portalManager = EasyMock
<a name="115" href="#115">115</a>                 .createNiceMock(IDashboardSharingPortalManager.<strong class="jxr_keyword">class</strong>);
<a name="116" href="#116">116</a>         EasyMock.expect(
<a name="117" href="#117">117</a>                 container.getComponentInstanceOfType(PortalManager.<strong class="jxr_keyword">class</strong>))
<a name="118" href="#118">118</a>                 .andStubReturn(portalManager);
<a name="119" href="#119">119</a> 
<a name="120" href="#120">120</a>         <em class="jxr_comment">// creates and registers JiraAuthenticationContext mock</em>
<a name="121" href="#121">121</a>         jiraAuthenticationContext = EasyMock
<a name="122" href="#122">122</a>                 .createMock(JiraAuthenticationContext.<strong class="jxr_keyword">class</strong>);
<a name="123" href="#123">123</a>         EasyMock
<a name="124" href="#124">124</a>                 .expect(
<a name="125" href="#125">125</a>                         container
<a name="126" href="#126">126</a>                                 .getComponentInstance(JiraAuthenticationContext.<strong class="jxr_keyword">class</strong>))
<a name="127" href="#127">127</a>                 .andStubReturn(jiraAuthenticationContext);
<a name="128" href="#128">128</a> 
<a name="129" href="#129">129</a>         <em class="jxr_comment">// creates and registers PermissionManager mock</em>
<a name="130" href="#130">130</a>         permissionManager = EasyMock.createMock(PermissionManager.<strong class="jxr_keyword">class</strong>);
<a name="131" href="#131">131</a>         EasyMock
<a name="132" href="#132">132</a>                 .expect(container.getComponentInstance(PermissionManager.<strong class="jxr_keyword">class</strong>))
<a name="133" href="#133">133</a>                 .andStubReturn(permissionManager);
<a name="134" href="#134">134</a> 
<a name="135" href="#135">135</a>         <em class="jxr_comment">// creates and registers GroupPermissionChecker mock</em>
<a name="136" href="#136">136</a>         groupPermissionChecker = EasyMock
<a name="137" href="#137">137</a>                 .createMock(GroupPermissionChecker.<strong class="jxr_keyword">class</strong>);
<a name="138" href="#138">138</a>         EasyMock
<a name="139" href="#139">139</a>                 .expect(
<a name="140" href="#140">140</a>                         container
<a name="141" href="#141">141</a>                                 .getComponentInstanceOfType(GroupPermissionChecker.<strong class="jxr_keyword">class</strong>))
<a name="142" href="#142">142</a>                 .andStubReturn(groupPermissionChecker);
<a name="143" href="#143">143</a> 
<a name="144" href="#144">144</a>         <em class="jxr_comment">// creates and registers EmailFormatter mock</em>
<a name="145" href="#145">145</a>         emailFormatter = EasyMock.createMock(EmailFormatter.<strong class="jxr_keyword">class</strong>);
<a name="146" href="#146">146</a>         EasyMock.expect(
<a name="147" href="#147">147</a>                 container.getComponentInstanceOfType(EmailFormatter.<strong class="jxr_keyword">class</strong>))
<a name="148" href="#148">148</a>                 .andStubReturn(emailFormatter);
<a name="149" href="#149">149</a> 
<a name="150" href="#150">150</a>         EasyMock.replay(container);
<a name="151" href="#151">151</a> 
<a name="152" href="#152">152</a>         <em class="jxr_comment">// set ComponentManager to refer to mock implementation of PicoContainer</em>
<a name="153" href="#153">153</a>         <em class="jxr_comment">// - 'container' reference</em>
<a name="154" href="#154">154</a>         ComponentManager componentManager = ComponentManager.getInstance();
<a name="155" href="#155">155</a>         Field containerField = ComponentManager.<strong class="jxr_keyword">class</strong>
<a name="156" href="#156">156</a>                 .getDeclaredField(<span class="jxr_string">"container"</span>);
<a name="157" href="#157">157</a>         containerField.setAccessible(<strong class="jxr_keyword">true</strong>);
<a name="158" href="#158">158</a>         containerField.set(componentManager, container);
<a name="159" href="#159">159</a> 
<a name="160" href="#160">160</a>         <em class="jxr_comment">// create session</em>
<a name="161" href="#161">161</a>         session = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Object&gt;();
<a name="162" href="#162">162</a>         ActionContext.setSession(session);
<a name="163" href="#163">163</a> 
<a name="164" href="#164">164</a>         <em class="jxr_comment">// sets logged user</em>
<a name="165" href="#165">165</a>         User user = createUser(USER_JUNG);
<a name="166" href="#166">166</a>         setLoggedInUser(user);
<a name="167" href="#167">167</a>     }
<a name="168" href="#168">168</a> 
<a name="169" href="#169">169</a>     <em class="jxr_javadoccomment">/**</em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     * @param user</em>
<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     */</em>
<a name="173" href="#173">173</a>     <strong class="jxr_keyword">protected</strong> Object setLoggedInUser(User user) { <em class="jxr_comment">// NOPMD by bosakrom on</em>
<a name="174" href="#174">174</a>         <em class="jxr_comment">// 23.4.08 18:15</em>
<a name="175" href="#175">175</a>         <strong class="jxr_keyword">return</strong> session.put(DefaultAuthenticator.LOGGED_IN_KEY, user);
<a name="176" href="#176">176</a>     }
<a name="177" href="#177">177</a> 
<a name="178" href="#178">178</a>     <em class="jxr_javadoccomment">/**</em>
<a name="179" href="#179">179</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">     */</em>
<a name="181" href="#181">181</a>     <strong class="jxr_keyword">protected</strong> User createUser(String name) { <em class="jxr_comment">// NOPMD by bosakrom on 23.4.08</em>
<a name="182" href="#182">182</a>         <em class="jxr_comment">// 18:15</em>
<a name="183" href="#183">183</a>         ProviderAccessor providerAccessor = EasyMock
<a name="184" href="#184">184</a>                 .createNiceMock(ProviderAccessor.<strong class="jxr_keyword">class</strong>);
<a name="185" href="#185">185</a>         CredentialsProvider credentialsProvider = EasyMock
<a name="186" href="#186">186</a>                 .createMock(CredentialsProvider.<strong class="jxr_keyword">class</strong>);
<a name="187" href="#187">187</a>         EasyMock.expect(providerAccessor.getCredentialsProvider(name))
<a name="188" href="#188">188</a>                 .andReturn(credentialsProvider);
<a name="189" href="#189">189</a>         EasyMock.expect(
<a name="190" href="#190">190</a>                 credentialsProvider.load(EasyMock.eq(name), EasyMock
<a name="191" href="#191">191</a>                         .isA(User.Accessor.<strong class="jxr_keyword">class</strong>))).andReturn(<strong class="jxr_keyword">true</strong>);
<a name="192" href="#192">192</a>         AccessProvider accessProvider = EasyMock
<a name="193" href="#193">193</a>                 .createMock(AccessProvider.<strong class="jxr_keyword">class</strong>);
<a name="194" href="#194">194</a>         EasyMock.expect(
<a name="195" href="#195">195</a>                 providerAccessor.getAccessProvider(EasyMock.isA(String.<strong class="jxr_keyword">class</strong>)))
<a name="196" href="#196">196</a>                 .andStubReturn(accessProvider);
<a name="197" href="#197">197</a>         EasyMock.replay(providerAccessor, credentialsProvider);
<a name="198" href="#198">198</a> 
<a name="199" href="#199">199</a>         User user = <strong class="jxr_keyword">new</strong> User(name, providerAccessor);
<a name="200" href="#200">200</a> 
<a name="201" href="#201">201</a>         <strong class="jxr_keyword">return</strong> user;
<a name="202" href="#202">202</a>     }
<a name="203" href="#203">203</a> 
<a name="204" href="#204">204</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

